﻿//-----------------------------------------------------------------------
// <copyright file="IMembershipService.cs" company="OOHM PROCESSAMENTO DE DADOS LTDA.">
//     Microsoft Public License (MS-PL) This license governs use of the accompanying
//     software. If you use the software, you accept this license. If you do not
//     accept the license, do not use the software. 1. Definitions The terms "reproduce,"
//     "reproduction," "derivative works," and "distribution" have the same meaning
//     here as under U.S. copyright law. A "contribution" is the original software,
//     or any additions or changes to the software. A "contributor" is any person
//     that distributes its contribution under this license. "Licensed patents"
//     are a contributor's patent claims that read directly on its contribution.
//     2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license,
//     including the license conditions and limitations in section 3, each contributor
//     grants you a non-exclusive, worldwide, royalty-free copyright license to
//     reproduce its contribution, prepare derivative works of its contribution,
//     and distribute its contribution or any derivative works that you create.
//     (B) Patent Grant- Subject to the terms of this license, including the license
//     conditions and limitations in section 3, each contributor grants you a non-exclusive,
//     worldwide, royalty-free license under its licensed patents to make, have
//     made, use, sell, offer for sale, import, and/or otherwise dispose of its
//     contribution in the software or derivative works of the contribution in
//     the software. 3. Conditions and Limitations (A) No Trademark License- This
//     license does not grant you rights to use any contributors' name, logo, or
//     trademarks. (B) If you bring a patent claim against any contributor over
//     patents that you claim are infringed by the software, your patent license
//     from such contributor to the software ends automatically. (C) If you distribute
//     any portion of the software, you must retain all copyright, patent, trademark,
//     and attribution notices that are present in the software. (D) If you distribute
//     any portion of the software in source code form, you may do so only under
//     this license by including a complete copy of this license with your distribution.
//     If you distribute any portion of the software in compiled or object code
//     form, you may only do so under a license that complies with this license.
//     (E) The software is licensed "as-is." You bear the risk of using it. The
//     contributors give no express warranties, guarantees or conditions. You may
//     have additional consumer rights under your local laws which this license
//     cannot change. To the extent permitted under your local laws, the contributors
//     exclude the implied warranties of merchantability, fitness for a particular
// </copyright>
//-----------------------------------------------------------------------
namespace AbstractSaaSTemplate.Domain.Services{    using AbstractSaaSTemplate.Domain.Models.Entities;
    using AbstractSaaSTemplate.Domain.Models.Enumerators;

    /// <summary>
    /// Describes the contract for the 'Membership' service.
    /// </summary>
    public interface IMembershipService : IService
    {
        /// <summary>
        /// Gets the minimum length for passwords in the system.
        /// </summary>
        int MinPasswordLength { get; }

        /// <summary>
        /// Gets the active member in the system
        /// </summary>
        User ActiveUser { get; }

        /// <summary>
        /// Generates a random password and retrieves it.
        /// </summary>
        /// <returns>Returns a string with a new password.</returns>
        string GenerateNewPassword();
        
        /// <summary>
        /// Checks if the credentials provided are valid in the system.
        /// </summary>
        /// <param name="login">The login to be checked</param>
        /// <param name="password">The password to be checked</param>
        /// <returns>Returns true if the credentials are valid; otherwise returns false.</returns>
        bool CheckCredentials(
            string login,
            string password);

        /// <summary>
        /// Checks the credentials and, if valid, performs the sign-in
        /// creating a session which can be used by the user to acccess
        /// the system.
        /// </summary>
        /// <param name="login">The login which will be checked and, if credentials pass, will be used to create the session.</param>
        /// <param name="password">The password which will be checked.</param>
        /// <param name="rememberMe">A value indicating whether a persistent session will be created or not</param>
        /// <returns>Returns true if credentials pass; otherwise returns false.</returns>
        bool LogOn(
            string login,
            string password,
            bool rememberMe);

        /// <summary>
        /// Destroys the session and stop user from being able to use the system.
        /// </summary>
        void LogOut();
        
        /// <summary>
        /// Checks if the credentials (login and oldPassword) are valid.
        /// If valid, changes credentials for a particular member
        /// </summary>
        /// <param name="login">The credential's login</param>
        /// <param name="oldPassword">The old password used to validate the credentials before changing it.</param>
        /// <param name="newPassword">The new password which will be set to the credentials.</param>
        /// <returns>Returns true if the credentials are valid and could be changed; otherwise returns false.</returns>
        bool ChangeCredentials(
            string login,
            string oldPassword,
            string newPassword);

        /// <summary>
        /// Changes the culture for one member into
        /// his/her profile so that it's retrieved correctly
        /// after the next log-on.
        /// </summary>
        /// <param name="login">The login of the user</param>
        /// <param name="newCultureName">The new culture to be used for this member</param>
        void ChangeCulture(
            string login,
            string newCultureName);

        /// <summary>
        /// Checks if a role has access to a particular feature.
        /// </summary>
        /// <param name="accessLevel">The access level of the role and feature.</param>
        /// <param name="role">The role which will be checked.</param>
        /// <param name="feature">The feature which is being accessed.</param>
        /// <returns>Returns true if the role is authorised for the feature. Otherwise returns false.</returns>
        bool HasRoleAccessToFeature(
            AccessLevels accessLevel,
            AccessRoles role,
            ControlledFeatures feature);

        /// <summary>
        /// Checks if a user is member of a particular role
        /// </summary>
        /// <param name="role">The role against we will check if the user is contained.</param>
        /// <returns>Returns true if the user is part of the role; otherwise returns false.</returns>
        bool IsActiveUserInRole(AccessRoles role);
    }
}


